[Key Vault] Add warnings to RSA_1_5 and RSA-OAEP documentation#32289
Merged
[Key Vault] Add warnings to RSA_1_5 and RSA-OAEP documentation#32289
Conversation
mccoyp
added
KeyVault
TypeSpec
mccoyp
requested review from
cheathamb36,
chen-karen,
heaths,
lgonsoulin and
vickm
as code owners
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Generated ApiView
|
github-actions
bot
removed
the
brownfield
Collaborator
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
This was referenced Jan 23, 2025
jackrichins
requested changes
Jan 23, 2025
Member
jackrichins
left a comment
jackrichins
left a comment
There was a problem hiding this comment.
There are 2 places where RSAES is incorrectly written instead of RSA_OAEP. It's a preexisting typo we should just fix now while we're at it. Other than those 2 minor typos, it looks great and I'm ready to approve everything else.
specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json
Show resolved
Hide resolved
jackrichins
approved these changes
Jan 23, 2025
Member
jackrichins
left a comment
jackrichins
left a comment
There was a problem hiding this comment.
Sorry about my previous comments. Should have read more, RSAES is the right term.
mccoyp
added
the
PublishToCustomers
heaths
approved these changes
Jan 24, 2025
markcowl
pushed a commit
to markcowl/azure-rest-api-specs
that referenced
this pull request
Feb 6, 2025
pjpatel12
pushed a commit
to pjpatel12/azure-rest-api-specs
that referenced
this pull request
Apr 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.This adds warnings to the descriptions of the RSA_1_5 and RSA-OAEP encryption algorithms, in alignment with other documented warnings. Key wrap examples are also updated to use RSA-OAEP-256 instead of RSA_1_5, with service return values updated accordingly.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Getting help
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.